<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.configuration;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.File;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.IOException;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.io.InputStream;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.io.InputStreamReader;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.io.OutputStream;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.io.OutputStreamWriter;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.io.Reader;<a name="line.26"></a>
<FONT color="green">027</FONT>    import java.io.UnsupportedEncodingException;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.io.Writer;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.net.URL;<a name="line.29"></a>
<FONT color="green">030</FONT>    import java.util.Iterator;<a name="line.30"></a>
<FONT color="green">031</FONT>    import java.util.LinkedList;<a name="line.31"></a>
<FONT color="green">032</FONT>    import java.util.List;<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.commons.configuration.reloading.InvariantReloadingStrategy;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.commons.configuration.reloading.ReloadingStrategy;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.commons.logging.LogFactory;<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>    /**<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;p&gt;Partial implementation of the {@code FileConfiguration} interface.<a name="line.40"></a>
<FONT color="green">041</FONT>     * Developers of file based configuration may want to extend this class,<a name="line.41"></a>
<FONT color="green">042</FONT>     * the two methods left to implement are {@link FileConfiguration#load(Reader)}<a name="line.42"></a>
<FONT color="green">043</FONT>     * and {@link FileConfiguration#save(Writer)}.&lt;/p&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * &lt;p&gt;This base class already implements a couple of ways to specify the location<a name="line.44"></a>
<FONT color="green">045</FONT>     * of the file this configuration is based on. The following possibilities<a name="line.45"></a>
<FONT color="green">046</FONT>     * exist:<a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;ul&gt;&lt;li&gt;URLs: With the method {@code setURL()} a full URL to the<a name="line.47"></a>
<FONT color="green">048</FONT>     * configuration source can be specified. This is the most flexible way. Note<a name="line.48"></a>
<FONT color="green">049</FONT>     * that the {@code save()} methods support only &lt;em&gt;file:&lt;/em&gt; URLs.&lt;/li&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     * &lt;li&gt;Files: The {@code setFile()} method allows to specify the<a name="line.50"></a>
<FONT color="green">051</FONT>     * configuration source as a file. This can be either a relative or an<a name="line.51"></a>
<FONT color="green">052</FONT>     * absolute file. In the former case the file is resolved based on the current<a name="line.52"></a>
<FONT color="green">053</FONT>     * directory.&lt;/li&gt;<a name="line.53"></a>
<FONT color="green">054</FONT>     * &lt;li&gt;As file paths in string form: With the {@code setPath()} method a<a name="line.54"></a>
<FONT color="green">055</FONT>     * full path to a configuration file can be provided as a string.&lt;/li&gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;li&gt;Separated as base path and file name: This is the native form in which<a name="line.56"></a>
<FONT color="green">057</FONT>     * the location is stored. The base path is a string defining either a local<a name="line.57"></a>
<FONT color="green">058</FONT>     * directory or a URL. It can be set using the {@code setBasePath()}<a name="line.58"></a>
<FONT color="green">059</FONT>     * method. The file name, non surprisingly, defines the name of the configuration<a name="line.59"></a>
<FONT color="green">060</FONT>     * file.&lt;/li&gt;&lt;/ul&gt;&lt;/p&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     * &lt;p&gt;The configuration source to be loaded can be specified using one of the<a name="line.61"></a>
<FONT color="green">062</FONT>     * methods described above. Then the parameterless {@code load()} method can be<a name="line.62"></a>
<FONT color="green">063</FONT>     * called. Alternatively, one of the {@code load()} methods can be used which is<a name="line.63"></a>
<FONT color="green">064</FONT>     * passed the source directly. These methods typically do not change the<a name="line.64"></a>
<FONT color="green">065</FONT>     * internally stored file; however, if the configuration is not yet associated<a name="line.65"></a>
<FONT color="green">066</FONT>     * with a configuration source, the first call to one of the {@code load()}<a name="line.66"></a>
<FONT color="green">067</FONT>     * methods sets the base path and the source URL. This fact has to be taken<a name="line.67"></a>
<FONT color="green">068</FONT>     * into account when calling {@code load()} multiple times with different file<a name="line.68"></a>
<FONT color="green">069</FONT>     * paths.&lt;/p&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     * &lt;p&gt;Note that the {@code load()} methods do not wipe out the configuration's<a name="line.70"></a>
<FONT color="green">071</FONT>     * content before the new configuration file is loaded. Thus it is very easy to<a name="line.71"></a>
<FONT color="green">072</FONT>     * construct a union configuration by simply loading multiple configuration<a name="line.72"></a>
<FONT color="green">073</FONT>     * files, e.g.&lt;/p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     * &lt;p&gt;&lt;pre&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     * config.load(configFile1);<a name="line.75"></a>
<FONT color="green">076</FONT>     * config.load(configFile2);<a name="line.76"></a>
<FONT color="green">077</FONT>     * &lt;/pre&gt;&lt;/p&gt;<a name="line.77"></a>
<FONT color="green">078</FONT>     * &lt;p&gt;After executing this code fragment, the resulting configuration will<a name="line.78"></a>
<FONT color="green">079</FONT>     * contain both the properties of configFile1 and configFile2. On the other<a name="line.79"></a>
<FONT color="green">080</FONT>     * hand, if the current configuration file is to be reloaded, {@code clear()}<a name="line.80"></a>
<FONT color="green">081</FONT>     * should be called first. Otherwise the properties are doubled. This behavior<a name="line.81"></a>
<FONT color="green">082</FONT>     * is analogous to the behavior of the {@code load(InputStream)} method<a name="line.82"></a>
<FONT color="green">083</FONT>     * in {@code java.util.Properties}.&lt;/p&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     *<a name="line.84"></a>
<FONT color="green">085</FONT>     * @author Emmanuel Bourg<a name="line.85"></a>
<FONT color="green">086</FONT>     * @version $Id: AbstractFileConfiguration.java 1234118 2012-01-20 20:36:04Z oheger $<a name="line.86"></a>
<FONT color="green">087</FONT>     * @since 1.0-rc2<a name="line.87"></a>
<FONT color="green">088</FONT>     */<a name="line.88"></a>
<FONT color="green">089</FONT>    public abstract class AbstractFileConfiguration<a name="line.89"></a>
<FONT color="green">090</FONT>    extends BaseConfiguration<a name="line.90"></a>
<FONT color="green">091</FONT>    implements FileConfiguration, FileSystemBased<a name="line.91"></a>
<FONT color="green">092</FONT>    {<a name="line.92"></a>
<FONT color="green">093</FONT>        /** Constant for the configuration reload event.*/<a name="line.93"></a>
<FONT color="green">094</FONT>        public static final int EVENT_RELOAD = 20;<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        /** Constant fro the configuration changed event. */<a name="line.96"></a>
<FONT color="green">097</FONT>        public static final int EVENT_CONFIG_CHANGED = 21;<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>        /** The root of the file scheme */<a name="line.99"></a>
<FONT color="green">100</FONT>        private static final String FILE_SCHEME = "file:";<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        /** Stores the file name.*/<a name="line.102"></a>
<FONT color="green">103</FONT>        protected String fileName;<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>        /** Stores the base path.*/<a name="line.105"></a>
<FONT color="green">106</FONT>        protected String basePath;<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>        /** The auto save flag.*/<a name="line.108"></a>
<FONT color="green">109</FONT>        protected boolean autoSave;<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>        /** Holds a reference to the reloading strategy.*/<a name="line.111"></a>
<FONT color="green">112</FONT>        protected ReloadingStrategy strategy;<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>        /** A lock object for protecting reload operations.*/<a name="line.114"></a>
<FONT color="green">115</FONT>        protected Object reloadLock = new Lock("AbstractFileConfiguration");<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>        /** Stores the encoding of the configuration file.*/<a name="line.117"></a>
<FONT color="green">118</FONT>        private String encoding;<a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>        /** Stores the URL from which the configuration file was loaded.*/<a name="line.120"></a>
<FONT color="green">121</FONT>        private URL sourceURL;<a name="line.121"></a>
<FONT color="green">122</FONT>    <a name="line.122"></a>
<FONT color="green">123</FONT>        /** A counter that prohibits reloading.*/<a name="line.123"></a>
<FONT color="green">124</FONT>        private int noReload;<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>        /** The FileSystem being used for this Configuration */<a name="line.126"></a>
<FONT color="green">127</FONT>        private FileSystem fileSystem = FileSystem.getDefaultFileSystem();<a name="line.127"></a>
<FONT color="green">128</FONT>    <a name="line.128"></a>
<FONT color="green">129</FONT>        /**<a name="line.129"></a>
<FONT color="green">130</FONT>         * Default constructor<a name="line.130"></a>
<FONT color="green">131</FONT>         *<a name="line.131"></a>
<FONT color="green">132</FONT>         * @since 1.1<a name="line.132"></a>
<FONT color="green">133</FONT>         */<a name="line.133"></a>
<FONT color="green">134</FONT>        public AbstractFileConfiguration()<a name="line.134"></a>
<FONT color="green">135</FONT>        {<a name="line.135"></a>
<FONT color="green">136</FONT>            initReloadingStrategy();<a name="line.136"></a>
<FONT color="green">137</FONT>            setLogger(LogFactory.getLog(getClass()));<a name="line.137"></a>
<FONT color="green">138</FONT>            addErrorLogListener();<a name="line.138"></a>
<FONT color="green">139</FONT>        }<a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>        /**<a name="line.141"></a>
<FONT color="green">142</FONT>         * Creates and loads the configuration from the specified file. The passed<a name="line.142"></a>
<FONT color="green">143</FONT>         * in string must be a valid file name, either absolute or relativ.<a name="line.143"></a>
<FONT color="green">144</FONT>         *<a name="line.144"></a>
<FONT color="green">145</FONT>         * @param fileName The name of the file to load.<a name="line.145"></a>
<FONT color="green">146</FONT>         *<a name="line.146"></a>
<FONT color="green">147</FONT>         * @throws ConfigurationException Error while loading the file<a name="line.147"></a>
<FONT color="green">148</FONT>         * @since 1.1<a name="line.148"></a>
<FONT color="green">149</FONT>         */<a name="line.149"></a>
<FONT color="green">150</FONT>        public AbstractFileConfiguration(String fileName) throws ConfigurationException<a name="line.150"></a>
<FONT color="green">151</FONT>        {<a name="line.151"></a>
<FONT color="green">152</FONT>            this();<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>            // store the file name<a name="line.154"></a>
<FONT color="green">155</FONT>            setFileName(fileName);<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>            // load the file<a name="line.157"></a>
<FONT color="green">158</FONT>            load();<a name="line.158"></a>
<FONT color="green">159</FONT>        }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>        /**<a name="line.161"></a>
<FONT color="green">162</FONT>         * Creates and loads the configuration from the specified file.<a name="line.162"></a>
<FONT color="green">163</FONT>         *<a name="line.163"></a>
<FONT color="green">164</FONT>         * @param file The file to load.<a name="line.164"></a>
<FONT color="green">165</FONT>         * @throws ConfigurationException Error while loading the file<a name="line.165"></a>
<FONT color="green">166</FONT>         * @since 1.1<a name="line.166"></a>
<FONT color="green">167</FONT>         */<a name="line.167"></a>
<FONT color="green">168</FONT>        public AbstractFileConfiguration(File file) throws ConfigurationException<a name="line.168"></a>
<FONT color="green">169</FONT>        {<a name="line.169"></a>
<FONT color="green">170</FONT>            this();<a name="line.170"></a>
<FONT color="green">171</FONT>    <a name="line.171"></a>
<FONT color="green">172</FONT>            // set the file and update the url, the base path and the file name<a name="line.172"></a>
<FONT color="green">173</FONT>            setFile(file);<a name="line.173"></a>
<FONT color="green">174</FONT>    <a name="line.174"></a>
<FONT color="green">175</FONT>            // load the file<a name="line.175"></a>
<FONT color="green">176</FONT>            if (file.exists())<a name="line.176"></a>
<FONT color="green">177</FONT>            {<a name="line.177"></a>
<FONT color="green">178</FONT>                load();<a name="line.178"></a>
<FONT color="green">179</FONT>            }<a name="line.179"></a>
<FONT color="green">180</FONT>        }<a name="line.180"></a>
<FONT color="green">181</FONT>    <a name="line.181"></a>
<FONT color="green">182</FONT>        /**<a name="line.182"></a>
<FONT color="green">183</FONT>         * Creates and loads the configuration from the specified URL.<a name="line.183"></a>
<FONT color="green">184</FONT>         *<a name="line.184"></a>
<FONT color="green">185</FONT>         * @param url The location of the file to load.<a name="line.185"></a>
<FONT color="green">186</FONT>         * @throws ConfigurationException Error while loading the file<a name="line.186"></a>
<FONT color="green">187</FONT>         * @since 1.1<a name="line.187"></a>
<FONT color="green">188</FONT>         */<a name="line.188"></a>
<FONT color="green">189</FONT>        public AbstractFileConfiguration(URL url) throws ConfigurationException<a name="line.189"></a>
<FONT color="green">190</FONT>        {<a name="line.190"></a>
<FONT color="green">191</FONT>            this();<a name="line.191"></a>
<FONT color="green">192</FONT>    <a name="line.192"></a>
<FONT color="green">193</FONT>            // set the URL and update the base path and the file name<a name="line.193"></a>
<FONT color="green">194</FONT>            setURL(url);<a name="line.194"></a>
<FONT color="green">195</FONT>    <a name="line.195"></a>
<FONT color="green">196</FONT>            // load the file<a name="line.196"></a>
<FONT color="green">197</FONT>            load();<a name="line.197"></a>
<FONT color="green">198</FONT>        }<a name="line.198"></a>
<FONT color="green">199</FONT>    <a name="line.199"></a>
<FONT color="green">200</FONT>        public void setFileSystem(FileSystem fileSystem)<a name="line.200"></a>
<FONT color="green">201</FONT>        {<a name="line.201"></a>
<FONT color="green">202</FONT>            if (fileSystem == null)<a name="line.202"></a>
<FONT color="green">203</FONT>            {<a name="line.203"></a>
<FONT color="green">204</FONT>                throw new NullPointerException("A valid FileSystem must be specified");<a name="line.204"></a>
<FONT color="green">205</FONT>            }<a name="line.205"></a>
<FONT color="green">206</FONT>            this.fileSystem = fileSystem;<a name="line.206"></a>
<FONT color="green">207</FONT>        }<a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>        public void resetFileSystem()<a name="line.209"></a>
<FONT color="green">210</FONT>        {<a name="line.210"></a>
<FONT color="green">211</FONT>            this.fileSystem = FileSystem.getDefaultFileSystem();<a name="line.211"></a>
<FONT color="green">212</FONT>        }<a name="line.212"></a>
<FONT color="green">213</FONT>    <a name="line.213"></a>
<FONT color="green">214</FONT>        public FileSystem getFileSystem()<a name="line.214"></a>
<FONT color="green">215</FONT>        {<a name="line.215"></a>
<FONT color="green">216</FONT>            return this.fileSystem;<a name="line.216"></a>
<FONT color="green">217</FONT>        }<a name="line.217"></a>
<FONT color="green">218</FONT>    <a name="line.218"></a>
<FONT color="green">219</FONT>        public Object getReloadLock()<a name="line.219"></a>
<FONT color="green">220</FONT>        {<a name="line.220"></a>
<FONT color="green">221</FONT>            return reloadLock;<a name="line.221"></a>
<FONT color="green">222</FONT>        }<a name="line.222"></a>
<FONT color="green">223</FONT>    <a name="line.223"></a>
<FONT color="green">224</FONT>    <a name="line.224"></a>
<FONT color="green">225</FONT>        /**<a name="line.225"></a>
<FONT color="green">226</FONT>         * Load the configuration from the underlying location.<a name="line.226"></a>
<FONT color="green">227</FONT>         *<a name="line.227"></a>
<FONT color="green">228</FONT>         * @throws ConfigurationException if loading of the configuration fails<a name="line.228"></a>
<FONT color="green">229</FONT>         */<a name="line.229"></a>
<FONT color="green">230</FONT>        public void load() throws ConfigurationException<a name="line.230"></a>
<FONT color="green">231</FONT>        {<a name="line.231"></a>
<FONT color="green">232</FONT>            if (sourceURL != null)<a name="line.232"></a>
<FONT color="green">233</FONT>            {<a name="line.233"></a>
<FONT color="green">234</FONT>                load(sourceURL);<a name="line.234"></a>
<FONT color="green">235</FONT>            }<a name="line.235"></a>
<FONT color="green">236</FONT>            else<a name="line.236"></a>
<FONT color="green">237</FONT>            {<a name="line.237"></a>
<FONT color="green">238</FONT>                load(getFileName());<a name="line.238"></a>
<FONT color="green">239</FONT>            }<a name="line.239"></a>
<FONT color="green">240</FONT>        }<a name="line.240"></a>
<FONT color="green">241</FONT>    <a name="line.241"></a>
<FONT color="green">242</FONT>        /**<a name="line.242"></a>
<FONT color="green">243</FONT>         * Locate the specified file and load the configuration. If the configuration is<a name="line.243"></a>
<FONT color="green">244</FONT>         * already associated with a source, the current source is not changed.<a name="line.244"></a>
<FONT color="green">245</FONT>         * Otherwise (i.e. this is the first load operation), the source URL and<a name="line.245"></a>
<FONT color="green">246</FONT>         * the base path are set now based on the source to be loaded.<a name="line.246"></a>
<FONT color="green">247</FONT>         *<a name="line.247"></a>
<FONT color="green">248</FONT>         * @param fileName the name of the file to be loaded<a name="line.248"></a>
<FONT color="green">249</FONT>         * @throws ConfigurationException if an error occurs<a name="line.249"></a>
<FONT color="green">250</FONT>         */<a name="line.250"></a>
<FONT color="green">251</FONT>        public void load(String fileName) throws ConfigurationException<a name="line.251"></a>
<FONT color="green">252</FONT>        {<a name="line.252"></a>
<FONT color="green">253</FONT>            try<a name="line.253"></a>
<FONT color="green">254</FONT>            {<a name="line.254"></a>
<FONT color="green">255</FONT>                URL url = ConfigurationUtils.locate(this.fileSystem, basePath, fileName);<a name="line.255"></a>
<FONT color="green">256</FONT>    <a name="line.256"></a>
<FONT color="green">257</FONT>                if (url == null)<a name="line.257"></a>
<FONT color="green">258</FONT>                {<a name="line.258"></a>
<FONT color="green">259</FONT>                    throw new ConfigurationException("Cannot locate configuration source " + fileName);<a name="line.259"></a>
<FONT color="green">260</FONT>                }<a name="line.260"></a>
<FONT color="green">261</FONT>                load(url);<a name="line.261"></a>
<FONT color="green">262</FONT>            }<a name="line.262"></a>
<FONT color="green">263</FONT>            catch (ConfigurationException e)<a name="line.263"></a>
<FONT color="green">264</FONT>            {<a name="line.264"></a>
<FONT color="green">265</FONT>                throw e;<a name="line.265"></a>
<FONT color="green">266</FONT>            }<a name="line.266"></a>
<FONT color="green">267</FONT>            catch (Exception e)<a name="line.267"></a>
<FONT color="green">268</FONT>            {<a name="line.268"></a>
<FONT color="green">269</FONT>                throw new ConfigurationException("Unable to load the configuration file " + fileName, e);<a name="line.269"></a>
<FONT color="green">270</FONT>            }<a name="line.270"></a>
<FONT color="green">271</FONT>        }<a name="line.271"></a>
<FONT color="green">272</FONT>    <a name="line.272"></a>
<FONT color="green">273</FONT>        /**<a name="line.273"></a>
<FONT color="green">274</FONT>         * Load the configuration from the specified file. If the configuration is<a name="line.274"></a>
<FONT color="green">275</FONT>         * already associated with a source, the current source is not changed.<a name="line.275"></a>
<FONT color="green">276</FONT>         * Otherwise (i.e. this is the first load operation), the source URL and<a name="line.276"></a>
<FONT color="green">277</FONT>         * the base path are set now based on the source to be loaded.<a name="line.277"></a>
<FONT color="green">278</FONT>         *<a name="line.278"></a>
<FONT color="green">279</FONT>         * @param file the file to load<a name="line.279"></a>
<FONT color="green">280</FONT>         * @throws ConfigurationException if an error occurs<a name="line.280"></a>
<FONT color="green">281</FONT>         */<a name="line.281"></a>
<FONT color="green">282</FONT>        public void load(File file) throws ConfigurationException<a name="line.282"></a>
<FONT color="green">283</FONT>        {<a name="line.283"></a>
<FONT color="green">284</FONT>            try<a name="line.284"></a>
<FONT color="green">285</FONT>            {<a name="line.285"></a>
<FONT color="green">286</FONT>                load(ConfigurationUtils.toURL(file));<a name="line.286"></a>
<FONT color="green">287</FONT>            }<a name="line.287"></a>
<FONT color="green">288</FONT>            catch (ConfigurationException e)<a name="line.288"></a>
<FONT color="green">289</FONT>            {<a name="line.289"></a>
<FONT color="green">290</FONT>                throw e;<a name="line.290"></a>
<FONT color="green">291</FONT>            }<a name="line.291"></a>
<FONT color="green">292</FONT>            catch (Exception e)<a name="line.292"></a>
<FONT color="green">293</FONT>            {<a name="line.293"></a>
<FONT color="green">294</FONT>                throw new ConfigurationException("Unable to load the configuration file " + file, e);<a name="line.294"></a>
<FONT color="green">295</FONT>            }<a name="line.295"></a>
<FONT color="green">296</FONT>        }<a name="line.296"></a>
<FONT color="green">297</FONT>    <a name="line.297"></a>
<FONT color="green">298</FONT>        /**<a name="line.298"></a>
<FONT color="green">299</FONT>         * Load the configuration from the specified URL. If the configuration is<a name="line.299"></a>
<FONT color="green">300</FONT>         * already associated with a source, the current source is not changed.<a name="line.300"></a>
<FONT color="green">301</FONT>         * Otherwise (i.e. this is the first load operation), the source URL and<a name="line.301"></a>
<FONT color="green">302</FONT>         * the base path are set now based on the source to be loaded.<a name="line.302"></a>
<FONT color="green">303</FONT>         *<a name="line.303"></a>
<FONT color="green">304</FONT>         * @param url the URL of the file to be loaded<a name="line.304"></a>
<FONT color="green">305</FONT>         * @throws ConfigurationException if an error occurs<a name="line.305"></a>
<FONT color="green">306</FONT>         */<a name="line.306"></a>
<FONT color="green">307</FONT>        public void load(URL url) throws ConfigurationException<a name="line.307"></a>
<FONT color="green">308</FONT>        {<a name="line.308"></a>
<FONT color="green">309</FONT>            if (sourceURL == null)<a name="line.309"></a>
<FONT color="green">310</FONT>            {<a name="line.310"></a>
<FONT color="green">311</FONT>                if (StringUtils.isEmpty(getBasePath()))<a name="line.311"></a>
<FONT color="green">312</FONT>                {<a name="line.312"></a>
<FONT color="green">313</FONT>                    // ensure that we have a valid base path<a name="line.313"></a>
<FONT color="green">314</FONT>                    setBasePath(url.toString());<a name="line.314"></a>
<FONT color="green">315</FONT>                }<a name="line.315"></a>
<FONT color="green">316</FONT>                sourceURL = url;<a name="line.316"></a>
<FONT color="green">317</FONT>            }<a name="line.317"></a>
<FONT color="green">318</FONT>    <a name="line.318"></a>
<FONT color="green">319</FONT>            InputStream in = null;<a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>            try<a name="line.321"></a>
<FONT color="green">322</FONT>            {<a name="line.322"></a>
<FONT color="green">323</FONT>                in = fileSystem.getInputStream(url);<a name="line.323"></a>
<FONT color="green">324</FONT>                load(in);<a name="line.324"></a>
<FONT color="green">325</FONT>            }<a name="line.325"></a>
<FONT color="green">326</FONT>            catch (ConfigurationException e)<a name="line.326"></a>
<FONT color="green">327</FONT>            {<a name="line.327"></a>
<FONT color="green">328</FONT>                throw e;<a name="line.328"></a>
<FONT color="green">329</FONT>            }<a name="line.329"></a>
<FONT color="green">330</FONT>            catch (Exception e)<a name="line.330"></a>
<FONT color="green">331</FONT>            {<a name="line.331"></a>
<FONT color="green">332</FONT>                throw new ConfigurationException("Unable to load the configuration from the URL " + url, e);<a name="line.332"></a>
<FONT color="green">333</FONT>            }<a name="line.333"></a>
<FONT color="green">334</FONT>            finally<a name="line.334"></a>
<FONT color="green">335</FONT>            {<a name="line.335"></a>
<FONT color="green">336</FONT>                // close the input stream<a name="line.336"></a>
<FONT color="green">337</FONT>                try<a name="line.337"></a>
<FONT color="green">338</FONT>                {<a name="line.338"></a>
<FONT color="green">339</FONT>                    if (in != null)<a name="line.339"></a>
<FONT color="green">340</FONT>                    {<a name="line.340"></a>
<FONT color="green">341</FONT>                        in.close();<a name="line.341"></a>
<FONT color="green">342</FONT>                    }<a name="line.342"></a>
<FONT color="green">343</FONT>                }<a name="line.343"></a>
<FONT color="green">344</FONT>                catch (IOException e)<a name="line.344"></a>
<FONT color="green">345</FONT>                {<a name="line.345"></a>
<FONT color="green">346</FONT>                    getLogger().warn("Could not close input stream", e);<a name="line.346"></a>
<FONT color="green">347</FONT>                }<a name="line.347"></a>
<FONT color="green">348</FONT>            }<a name="line.348"></a>
<FONT color="green">349</FONT>        }<a name="line.349"></a>
<FONT color="green">350</FONT>    <a name="line.350"></a>
<FONT color="green">351</FONT>        /**<a name="line.351"></a>
<FONT color="green">352</FONT>         * Load the configuration from the specified stream, using the encoding<a name="line.352"></a>
<FONT color="green">353</FONT>         * returned by {@link #getEncoding()}.<a name="line.353"></a>
<FONT color="green">354</FONT>         *<a name="line.354"></a>
<FONT color="green">355</FONT>         * @param in the input stream<a name="line.355"></a>
<FONT color="green">356</FONT>         *<a name="line.356"></a>
<FONT color="green">357</FONT>         * @throws ConfigurationException if an error occurs during the load operation<a name="line.357"></a>
<FONT color="green">358</FONT>         */<a name="line.358"></a>
<FONT color="green">359</FONT>        public void load(InputStream in) throws ConfigurationException<a name="line.359"></a>
<FONT color="green">360</FONT>        {<a name="line.360"></a>
<FONT color="green">361</FONT>            load(in, getEncoding());<a name="line.361"></a>
<FONT color="green">362</FONT>        }<a name="line.362"></a>
<FONT color="green">363</FONT>    <a name="line.363"></a>
<FONT color="green">364</FONT>        /**<a name="line.364"></a>
<FONT color="green">365</FONT>         * Load the configuration from the specified stream, using the specified<a name="line.365"></a>
<FONT color="green">366</FONT>         * encoding. If the encoding is null the default encoding is used.<a name="line.366"></a>
<FONT color="green">367</FONT>         *<a name="line.367"></a>
<FONT color="green">368</FONT>         * @param in the input stream<a name="line.368"></a>
<FONT color="green">369</FONT>         * @param encoding the encoding used. {@code null} to use the default encoding<a name="line.369"></a>
<FONT color="green">370</FONT>         *<a name="line.370"></a>
<FONT color="green">371</FONT>         * @throws ConfigurationException if an error occurs during the load operation<a name="line.371"></a>
<FONT color="green">372</FONT>         */<a name="line.372"></a>
<FONT color="green">373</FONT>        public void load(InputStream in, String encoding) throws ConfigurationException<a name="line.373"></a>
<FONT color="green">374</FONT>        {<a name="line.374"></a>
<FONT color="green">375</FONT>            Reader reader = null;<a name="line.375"></a>
<FONT color="green">376</FONT>    <a name="line.376"></a>
<FONT color="green">377</FONT>            if (encoding != null)<a name="line.377"></a>
<FONT color="green">378</FONT>            {<a name="line.378"></a>
<FONT color="green">379</FONT>                try<a name="line.379"></a>
<FONT color="green">380</FONT>                {<a name="line.380"></a>
<FONT color="green">381</FONT>                    reader = new InputStreamReader(in, encoding);<a name="line.381"></a>
<FONT color="green">382</FONT>                }<a name="line.382"></a>
<FONT color="green">383</FONT>                catch (UnsupportedEncodingException e)<a name="line.383"></a>
<FONT color="green">384</FONT>                {<a name="line.384"></a>
<FONT color="green">385</FONT>                    throw new ConfigurationException(<a name="line.385"></a>
<FONT color="green">386</FONT>                            "The requested encoding is not supported, try the default encoding.", e);<a name="line.386"></a>
<FONT color="green">387</FONT>                }<a name="line.387"></a>
<FONT color="green">388</FONT>            }<a name="line.388"></a>
<FONT color="green">389</FONT>    <a name="line.389"></a>
<FONT color="green">390</FONT>            if (reader == null)<a name="line.390"></a>
<FONT color="green">391</FONT>            {<a name="line.391"></a>
<FONT color="green">392</FONT>                reader = new InputStreamReader(in);<a name="line.392"></a>
<FONT color="green">393</FONT>            }<a name="line.393"></a>
<FONT color="green">394</FONT>    <a name="line.394"></a>
<FONT color="green">395</FONT>            load(reader);<a name="line.395"></a>
<FONT color="green">396</FONT>        }<a name="line.396"></a>
<FONT color="green">397</FONT>    <a name="line.397"></a>
<FONT color="green">398</FONT>        /**<a name="line.398"></a>
<FONT color="green">399</FONT>         * Save the configuration. Before this method can be called a valid file<a name="line.399"></a>
<FONT color="green">400</FONT>         * name must have been set.<a name="line.400"></a>
<FONT color="green">401</FONT>         *<a name="line.401"></a>
<FONT color="green">402</FONT>         * @throws ConfigurationException if an error occurs or no file name has<a name="line.402"></a>
<FONT color="green">403</FONT>         * been set yet<a name="line.403"></a>
<FONT color="green">404</FONT>         */<a name="line.404"></a>
<FONT color="green">405</FONT>        public void save() throws ConfigurationException<a name="line.405"></a>
<FONT color="green">406</FONT>        {<a name="line.406"></a>
<FONT color="green">407</FONT>            if (getFileName() == null)<a name="line.407"></a>
<FONT color="green">408</FONT>            {<a name="line.408"></a>
<FONT color="green">409</FONT>                throw new ConfigurationException("No file name has been set!");<a name="line.409"></a>
<FONT color="green">410</FONT>            }<a name="line.410"></a>
<FONT color="green">411</FONT>    <a name="line.411"></a>
<FONT color="green">412</FONT>            if (sourceURL != null)<a name="line.412"></a>
<FONT color="green">413</FONT>            {<a name="line.413"></a>
<FONT color="green">414</FONT>                save(sourceURL);<a name="line.414"></a>
<FONT color="green">415</FONT>            }<a name="line.415"></a>
<FONT color="green">416</FONT>            else<a name="line.416"></a>
<FONT color="green">417</FONT>            {<a name="line.417"></a>
<FONT color="green">418</FONT>                save(fileName);<a name="line.418"></a>
<FONT color="green">419</FONT>            }<a name="line.419"></a>
<FONT color="green">420</FONT>            strategy.init();<a name="line.420"></a>
<FONT color="green">421</FONT>        }<a name="line.421"></a>
<FONT color="green">422</FONT>    <a name="line.422"></a>
<FONT color="green">423</FONT>        /**<a name="line.423"></a>
<FONT color="green">424</FONT>         * Save the configuration to the specified file. This doesn't change the<a name="line.424"></a>
<FONT color="green">425</FONT>         * source of the configuration, use setFileName() if you need it.<a name="line.425"></a>
<FONT color="green">426</FONT>         *<a name="line.426"></a>
<FONT color="green">427</FONT>         * @param fileName the file name<a name="line.427"></a>
<FONT color="green">428</FONT>         *<a name="line.428"></a>
<FONT color="green">429</FONT>         * @throws ConfigurationException if an error occurs during the save operation<a name="line.429"></a>
<FONT color="green">430</FONT>         */<a name="line.430"></a>
<FONT color="green">431</FONT>        public void save(String fileName) throws ConfigurationException<a name="line.431"></a>
<FONT color="green">432</FONT>        {<a name="line.432"></a>
<FONT color="green">433</FONT>            try<a name="line.433"></a>
<FONT color="green">434</FONT>            {<a name="line.434"></a>
<FONT color="green">435</FONT>                URL url = this.fileSystem.getURL(basePath, fileName);<a name="line.435"></a>
<FONT color="green">436</FONT>    <a name="line.436"></a>
<FONT color="green">437</FONT>                if (url == null)<a name="line.437"></a>
<FONT color="green">438</FONT>                {<a name="line.438"></a>
<FONT color="green">439</FONT>                    throw new ConfigurationException("Cannot locate configuration source " + fileName);<a name="line.439"></a>
<FONT color="green">440</FONT>                }<a name="line.440"></a>
<FONT color="green">441</FONT>                save(url);<a name="line.441"></a>
<FONT color="green">442</FONT>                /*File file = ConfigurationUtils.getFile(basePath, fileName);<a name="line.442"></a>
<FONT color="green">443</FONT>                if (file == null)<a name="line.443"></a>
<FONT color="green">444</FONT>                {<a name="line.444"></a>
<FONT color="green">445</FONT>                    throw new ConfigurationException("Invalid file name for save: " + fileName);<a name="line.445"></a>
<FONT color="green">446</FONT>                }<a name="line.446"></a>
<FONT color="green">447</FONT>                save(file); */<a name="line.447"></a>
<FONT color="green">448</FONT>            }<a name="line.448"></a>
<FONT color="green">449</FONT>            catch (ConfigurationException e)<a name="line.449"></a>
<FONT color="green">450</FONT>            {<a name="line.450"></a>
<FONT color="green">451</FONT>                throw e;<a name="line.451"></a>
<FONT color="green">452</FONT>            }<a name="line.452"></a>
<FONT color="green">453</FONT>            catch (Exception e)<a name="line.453"></a>
<FONT color="green">454</FONT>            {<a name="line.454"></a>
<FONT color="green">455</FONT>                throw new ConfigurationException("Unable to save the configuration to the file " + fileName, e);<a name="line.455"></a>
<FONT color="green">456</FONT>            }<a name="line.456"></a>
<FONT color="green">457</FONT>        }<a name="line.457"></a>
<FONT color="green">458</FONT>    <a name="line.458"></a>
<FONT color="green">459</FONT>        /**<a name="line.459"></a>
<FONT color="green">460</FONT>         * Save the configuration to the specified URL.<a name="line.460"></a>
<FONT color="green">461</FONT>         * This doesn't change the source of the configuration, use setURL()<a name="line.461"></a>
<FONT color="green">462</FONT>         * if you need it.<a name="line.462"></a>
<FONT color="green">463</FONT>         *<a name="line.463"></a>
<FONT color="green">464</FONT>         * @param url the URL<a name="line.464"></a>
<FONT color="green">465</FONT>         *<a name="line.465"></a>
<FONT color="green">466</FONT>         * @throws ConfigurationException if an error occurs during the save operation<a name="line.466"></a>
<FONT color="green">467</FONT>         */<a name="line.467"></a>
<FONT color="green">468</FONT>        public void save(URL url) throws ConfigurationException<a name="line.468"></a>
<FONT color="green">469</FONT>        {<a name="line.469"></a>
<FONT color="green">470</FONT>            OutputStream out = null;<a name="line.470"></a>
<FONT color="green">471</FONT>            try<a name="line.471"></a>
<FONT color="green">472</FONT>            {<a name="line.472"></a>
<FONT color="green">473</FONT>                out = fileSystem.getOutputStream(url);<a name="line.473"></a>
<FONT color="green">474</FONT>                save(out);<a name="line.474"></a>
<FONT color="green">475</FONT>                if (out instanceof VerifiableOutputStream)<a name="line.475"></a>
<FONT color="green">476</FONT>                {<a name="line.476"></a>
<FONT color="green">477</FONT>                    ((VerifiableOutputStream) out).verify();<a name="line.477"></a>
<FONT color="green">478</FONT>                }<a name="line.478"></a>
<FONT color="green">479</FONT>            }<a name="line.479"></a>
<FONT color="green">480</FONT>            catch (IOException e)<a name="line.480"></a>
<FONT color="green">481</FONT>            {<a name="line.481"></a>
<FONT color="green">482</FONT>                throw new ConfigurationException("Could not save to URL " + url, e);<a name="line.482"></a>
<FONT color="green">483</FONT>            }<a name="line.483"></a>
<FONT color="green">484</FONT>            finally<a name="line.484"></a>
<FONT color="green">485</FONT>            {<a name="line.485"></a>
<FONT color="green">486</FONT>                closeSilent(out);<a name="line.486"></a>
<FONT color="green">487</FONT>            }<a name="line.487"></a>
<FONT color="green">488</FONT>        }<a name="line.488"></a>
<FONT color="green">489</FONT>    <a name="line.489"></a>
<FONT color="green">490</FONT>        /**<a name="line.490"></a>
<FONT color="green">491</FONT>         * Save the configuration to the specified file. The file is created<a name="line.491"></a>
<FONT color="green">492</FONT>         * automatically if it doesn't exist. This doesn't change the source<a name="line.492"></a>
<FONT color="green">493</FONT>         * of the configuration, use {@link #setFile} if you need it.<a name="line.493"></a>
<FONT color="green">494</FONT>         *<a name="line.494"></a>
<FONT color="green">495</FONT>         * @param file the target file<a name="line.495"></a>
<FONT color="green">496</FONT>         *<a name="line.496"></a>
<FONT color="green">497</FONT>         * @throws ConfigurationException if an error occurs during the save operation<a name="line.497"></a>
<FONT color="green">498</FONT>         */<a name="line.498"></a>
<FONT color="green">499</FONT>        public void save(File file) throws ConfigurationException<a name="line.499"></a>
<FONT color="green">500</FONT>        {<a name="line.500"></a>
<FONT color="green">501</FONT>            OutputStream out = null;<a name="line.501"></a>
<FONT color="green">502</FONT>    <a name="line.502"></a>
<FONT color="green">503</FONT>            try<a name="line.503"></a>
<FONT color="green">504</FONT>            {<a name="line.504"></a>
<FONT color="green">505</FONT>                out = fileSystem.getOutputStream(file);<a name="line.505"></a>
<FONT color="green">506</FONT>                save(out);<a name="line.506"></a>
<FONT color="green">507</FONT>            }<a name="line.507"></a>
<FONT color="green">508</FONT>            finally<a name="line.508"></a>
<FONT color="green">509</FONT>            {<a name="line.509"></a>
<FONT color="green">510</FONT>                closeSilent(out);<a name="line.510"></a>
<FONT color="green">511</FONT>            }<a name="line.511"></a>
<FONT color="green">512</FONT>        }<a name="line.512"></a>
<FONT color="green">513</FONT>    <a name="line.513"></a>
<FONT color="green">514</FONT>        /**<a name="line.514"></a>
<FONT color="green">515</FONT>         * Save the configuration to the specified stream, using the encoding<a name="line.515"></a>
<FONT color="green">516</FONT>         * returned by {@link #getEncoding()}.<a name="line.516"></a>
<FONT color="green">517</FONT>         *<a name="line.517"></a>
<FONT color="green">518</FONT>         * @param out the output stream<a name="line.518"></a>
<FONT color="green">519</FONT>         *<a name="line.519"></a>
<FONT color="green">520</FONT>         * @throws ConfigurationException if an error occurs during the save operation<a name="line.520"></a>
<FONT color="green">521</FONT>         */<a name="line.521"></a>
<FONT color="green">522</FONT>        public void save(OutputStream out) throws ConfigurationException<a name="line.522"></a>
<FONT color="green">523</FONT>        {<a name="line.523"></a>
<FONT color="green">524</FONT>            save(out, getEncoding());<a name="line.524"></a>
<FONT color="green">525</FONT>        }<a name="line.525"></a>
<FONT color="green">526</FONT>    <a name="line.526"></a>
<FONT color="green">527</FONT>        /**<a name="line.527"></a>
<FONT color="green">528</FONT>         * Save the configuration to the specified stream, using the specified<a name="line.528"></a>
<FONT color="green">529</FONT>         * encoding. If the encoding is null the default encoding is used.<a name="line.529"></a>
<FONT color="green">530</FONT>         *<a name="line.530"></a>
<FONT color="green">531</FONT>         * @param out the output stream<a name="line.531"></a>
<FONT color="green">532</FONT>         * @param encoding the encoding to use<a name="line.532"></a>
<FONT color="green">533</FONT>         * @throws ConfigurationException if an error occurs during the save operation<a name="line.533"></a>
<FONT color="green">534</FONT>         */<a name="line.534"></a>
<FONT color="green">535</FONT>        public void save(OutputStream out, String encoding) throws ConfigurationException<a name="line.535"></a>
<FONT color="green">536</FONT>        {<a name="line.536"></a>
<FONT color="green">537</FONT>            Writer writer = null;<a name="line.537"></a>
<FONT color="green">538</FONT>    <a name="line.538"></a>
<FONT color="green">539</FONT>            if (encoding != null)<a name="line.539"></a>
<FONT color="green">540</FONT>            {<a name="line.540"></a>
<FONT color="green">541</FONT>                try<a name="line.541"></a>
<FONT color="green">542</FONT>                {<a name="line.542"></a>
<FONT color="green">543</FONT>                    writer = new OutputStreamWriter(out, encoding);<a name="line.543"></a>
<FONT color="green">544</FONT>                }<a name="line.544"></a>
<FONT color="green">545</FONT>                catch (UnsupportedEncodingException e)<a name="line.545"></a>
<FONT color="green">546</FONT>                {<a name="line.546"></a>
<FONT color="green">547</FONT>                    throw new ConfigurationException(<a name="line.547"></a>
<FONT color="green">548</FONT>                            "The requested encoding is not supported, try the default encoding.", e);<a name="line.548"></a>
<FONT color="green">549</FONT>                }<a name="line.549"></a>
<FONT color="green">550</FONT>            }<a name="line.550"></a>
<FONT color="green">551</FONT>    <a name="line.551"></a>
<FONT color="green">552</FONT>            if (writer == null)<a name="line.552"></a>
<FONT color="green">553</FONT>            {<a name="line.553"></a>
<FONT color="green">554</FONT>                writer = new OutputStreamWriter(out);<a name="line.554"></a>
<FONT color="green">555</FONT>            }<a name="line.555"></a>
<FONT color="green">556</FONT>    <a name="line.556"></a>
<FONT color="green">557</FONT>            save(writer);<a name="line.557"></a>
<FONT color="green">558</FONT>        }<a name="line.558"></a>
<FONT color="green">559</FONT>    <a name="line.559"></a>
<FONT color="green">560</FONT>        /**<a name="line.560"></a>
<FONT color="green">561</FONT>         * Return the name of the file.<a name="line.561"></a>
<FONT color="green">562</FONT>         *<a name="line.562"></a>
<FONT color="green">563</FONT>         * @return the file name<a name="line.563"></a>
<FONT color="green">564</FONT>         */<a name="line.564"></a>
<FONT color="green">565</FONT>        public String getFileName()<a name="line.565"></a>
<FONT color="green">566</FONT>        {<a name="line.566"></a>
<FONT color="green">567</FONT>            return fileName;<a name="line.567"></a>
<FONT color="green">568</FONT>        }<a name="line.568"></a>
<FONT color="green">569</FONT>    <a name="line.569"></a>
<FONT color="green">570</FONT>        /**<a name="line.570"></a>
<FONT color="green">571</FONT>         * Set the name of the file. The passed in file name can contain a<a name="line.571"></a>
<FONT color="green">572</FONT>         * relative path.<a name="line.572"></a>
<FONT color="green">573</FONT>         * It must be used when referring files with relative paths from classpath.<a name="line.573"></a>
<FONT color="green">574</FONT>         * Use {@link AbstractFileConfiguration#setPath(String)<a name="line.574"></a>
<FONT color="green">575</FONT>         * setPath()} to set a full qualified file name.<a name="line.575"></a>
<FONT color="green">576</FONT>         *<a name="line.576"></a>
<FONT color="green">577</FONT>         * @param fileName the name of the file<a name="line.577"></a>
<FONT color="green">578</FONT>         */<a name="line.578"></a>
<FONT color="green">579</FONT>        public void setFileName(String fileName)<a name="line.579"></a>
<FONT color="green">580</FONT>        {<a name="line.580"></a>
<FONT color="green">581</FONT>            if (fileName != null &amp;&amp; fileName.startsWith(FILE_SCHEME) &amp;&amp; !fileName.startsWith("file://"))<a name="line.581"></a>
<FONT color="green">582</FONT>            {<a name="line.582"></a>
<FONT color="green">583</FONT>                fileName = "file://" + fileName.substring(FILE_SCHEME.length());<a name="line.583"></a>
<FONT color="green">584</FONT>            }<a name="line.584"></a>
<FONT color="green">585</FONT>    <a name="line.585"></a>
<FONT color="green">586</FONT>            sourceURL = null;<a name="line.586"></a>
<FONT color="green">587</FONT>            this.fileName = fileName;<a name="line.587"></a>
<FONT color="green">588</FONT>            getLogger().debug("FileName set to " + fileName);<a name="line.588"></a>
<FONT color="green">589</FONT>        }<a name="line.589"></a>
<FONT color="green">590</FONT>    <a name="line.590"></a>
<FONT color="green">591</FONT>        /**<a name="line.591"></a>
<FONT color="green">592</FONT>         * Return the base path.<a name="line.592"></a>
<FONT color="green">593</FONT>         *<a name="line.593"></a>
<FONT color="green">594</FONT>         * @return the base path<a name="line.594"></a>
<FONT color="green">595</FONT>         * @see FileConfiguration#getBasePath()<a name="line.595"></a>
<FONT color="green">596</FONT>         */<a name="line.596"></a>
<FONT color="green">597</FONT>        public String getBasePath()<a name="line.597"></a>
<FONT color="green">598</FONT>        {<a name="line.598"></a>
<FONT color="green">599</FONT>            return basePath;<a name="line.599"></a>
<FONT color="green">600</FONT>        }<a name="line.600"></a>
<FONT color="green">601</FONT>    <a name="line.601"></a>
<FONT color="green">602</FONT>        /**<a name="line.602"></a>
<FONT color="green">603</FONT>         * Sets the base path. The base path is typically either a path to a<a name="line.603"></a>
<FONT color="green">604</FONT>         * directory or a URL. Together with the value passed to the<a name="line.604"></a>
<FONT color="green">605</FONT>         * {@code setFileName()} method it defines the location of the<a name="line.605"></a>
<FONT color="green">606</FONT>         * configuration file to be loaded. The strategies for locating the file are<a name="line.606"></a>
<FONT color="green">607</FONT>         * quite tolerant. For instance if the file name is already an absolute path<a name="line.607"></a>
<FONT color="green">608</FONT>         * or a fully defined URL, the base path will be ignored. The base path can<a name="line.608"></a>
<FONT color="green">609</FONT>         * also be a URL, in which case the file name is interpreted in this URL's<a name="line.609"></a>
<FONT color="green">610</FONT>         * context. Because the base path is used by some of the derived classes for<a name="line.610"></a>
<FONT color="green">611</FONT>         * resolving relative file names it should contain a meaningful value. If<a name="line.611"></a>
<FONT color="green">612</FONT>         * other methods are used for determining the location of the configuration<a name="line.612"></a>
<FONT color="green">613</FONT>         * file (e.g. {@code setFile()} or {@code setURL()}), the<a name="line.613"></a>
<FONT color="green">614</FONT>         * base path is automatically set.<a name="line.614"></a>
<FONT color="green">615</FONT>         *<a name="line.615"></a>
<FONT color="green">616</FONT>         * @param basePath the base path.<a name="line.616"></a>
<FONT color="green">617</FONT>         */<a name="line.617"></a>
<FONT color="green">618</FONT>        public void setBasePath(String basePath)<a name="line.618"></a>
<FONT color="green">619</FONT>        {<a name="line.619"></a>
<FONT color="green">620</FONT>            if (basePath != null &amp;&amp; basePath.startsWith(FILE_SCHEME) &amp;&amp; !basePath.startsWith("file://"))<a name="line.620"></a>
<FONT color="green">621</FONT>            {<a name="line.621"></a>
<FONT color="green">622</FONT>                basePath = "file://" + basePath.substring(FILE_SCHEME.length());<a name="line.622"></a>
<FONT color="green">623</FONT>            }<a name="line.623"></a>
<FONT color="green">624</FONT>            sourceURL = null;<a name="line.624"></a>
<FONT color="green">625</FONT>            this.basePath = basePath;<a name="line.625"></a>
<FONT color="green">626</FONT>            getLogger().debug("Base path set to " + basePath);<a name="line.626"></a>
<FONT color="green">627</FONT>        }<a name="line.627"></a>
<FONT color="green">628</FONT>    <a name="line.628"></a>
<FONT color="green">629</FONT>        /**<a name="line.629"></a>
<FONT color="green">630</FONT>         * Return the file where the configuration is stored. If the base path is a<a name="line.630"></a>
<FONT color="green">631</FONT>         * URL with a protocol different than &amp;quot;file&amp;quot;, or the configuration<a name="line.631"></a>
<FONT color="green">632</FONT>         * file is within a compressed archive, the return value<a name="line.632"></a>
<FONT color="green">633</FONT>         * will not point to a valid file object.<a name="line.633"></a>
<FONT color="green">634</FONT>         *<a name="line.634"></a>
<FONT color="green">635</FONT>         * @return the file where the configuration is stored; this can be &lt;b&gt;null&lt;/b&gt;<a name="line.635"></a>
<FONT color="green">636</FONT>         */<a name="line.636"></a>
<FONT color="green">637</FONT>        public File getFile()<a name="line.637"></a>
<FONT color="green">638</FONT>        {<a name="line.638"></a>
<FONT color="green">639</FONT>            if (getFileName() == null &amp;&amp; sourceURL == null)<a name="line.639"></a>
<FONT color="green">640</FONT>            {<a name="line.640"></a>
<FONT color="green">641</FONT>                return null;<a name="line.641"></a>
<FONT color="green">642</FONT>            }<a name="line.642"></a>
<FONT color="green">643</FONT>            else if (sourceURL != null)<a name="line.643"></a>
<FONT color="green">644</FONT>            {<a name="line.644"></a>
<FONT color="green">645</FONT>                return ConfigurationUtils.fileFromURL(sourceURL);<a name="line.645"></a>
<FONT color="green">646</FONT>            }<a name="line.646"></a>
<FONT color="green">647</FONT>            else<a name="line.647"></a>
<FONT color="green">648</FONT>            {<a name="line.648"></a>
<FONT color="green">649</FONT>                return ConfigurationUtils.getFile(getBasePath(), getFileName());<a name="line.649"></a>
<FONT color="green">650</FONT>            }<a name="line.650"></a>
<FONT color="green">651</FONT>        }<a name="line.651"></a>
<FONT color="green">652</FONT>    <a name="line.652"></a>
<FONT color="green">653</FONT>        /**<a name="line.653"></a>
<FONT color="green">654</FONT>         * Set the file where the configuration is stored. The passed in file is<a name="line.654"></a>
<FONT color="green">655</FONT>         * made absolute if it is not yet. Then the file's path component becomes<a name="line.655"></a>
<FONT color="green">656</FONT>         * the base path and its name component becomes the file name.<a name="line.656"></a>
<FONT color="green">657</FONT>         *<a name="line.657"></a>
<FONT color="green">658</FONT>         * @param file the file where the configuration is stored<a name="line.658"></a>
<FONT color="green">659</FONT>         */<a name="line.659"></a>
<FONT color="green">660</FONT>        public void setFile(File file)<a name="line.660"></a>
<FONT color="green">661</FONT>        {<a name="line.661"></a>
<FONT color="green">662</FONT>            sourceURL = null;<a name="line.662"></a>
<FONT color="green">663</FONT>            setFileName(file.getName());<a name="line.663"></a>
<FONT color="green">664</FONT>            setBasePath((file.getParentFile() != null) ? file.getParentFile()<a name="line.664"></a>
<FONT color="green">665</FONT>                    .getAbsolutePath() : null);<a name="line.665"></a>
<FONT color="green">666</FONT>        }<a name="line.666"></a>
<FONT color="green">667</FONT>    <a name="line.667"></a>
<FONT color="green">668</FONT>        /**<a name="line.668"></a>
<FONT color="green">669</FONT>         * Returns the full path to the file this configuration is based on. The<a name="line.669"></a>
<FONT color="green">670</FONT>         * return value is a valid File path only if this configuration is based on<a name="line.670"></a>
<FONT color="green">671</FONT>         * a file on the local disk.<a name="line.671"></a>
<FONT color="green">672</FONT>         * If the configuration was loaded from a packed archive the returned value<a name="line.672"></a>
<FONT color="green">673</FONT>         * is the string form of the URL from which the configuration was loaded.<a name="line.673"></a>
<FONT color="green">674</FONT>         *<a name="line.674"></a>
<FONT color="green">675</FONT>         * @return the full path to the configuration file<a name="line.675"></a>
<FONT color="green">676</FONT>         */<a name="line.676"></a>
<FONT color="green">677</FONT>        public String getPath()<a name="line.677"></a>
<FONT color="green">678</FONT>        {<a name="line.678"></a>
<FONT color="green">679</FONT>            return fileSystem.getPath(getFile(), sourceURL, getBasePath(), getFileName());<a name="line.679"></a>
<FONT color="green">680</FONT>        }<a name="line.680"></a>
<FONT color="green">681</FONT>    <a name="line.681"></a>
<FONT color="green">682</FONT>        /**<a name="line.682"></a>
<FONT color="green">683</FONT>         * Sets the location of this configuration as a full or relative path name.<a name="line.683"></a>
<FONT color="green">684</FONT>         * The passed in path should represent a valid file name on the file system.<a name="line.684"></a>
<FONT color="green">685</FONT>         * It must not be used to specify relative paths for files that exist<a name="line.685"></a>
<FONT color="green">686</FONT>         * in classpath, either plain file system or compressed archive,<a name="line.686"></a>
<FONT color="green">687</FONT>         * because this method expands any relative path to an absolute one which<a name="line.687"></a>
<FONT color="green">688</FONT>         * may end in an invalid absolute path for classpath references.<a name="line.688"></a>
<FONT color="green">689</FONT>         *<a name="line.689"></a>
<FONT color="green">690</FONT>         * @param path the full path name of the configuration file<a name="line.690"></a>
<FONT color="green">691</FONT>         */<a name="line.691"></a>
<FONT color="green">692</FONT>        public void setPath(String path)<a name="line.692"></a>
<FONT color="green">693</FONT>        {<a name="line.693"></a>
<FONT color="green">694</FONT>            setFile(new File(path));<a name="line.694"></a>
<FONT color="green">695</FONT>        }<a name="line.695"></a>
<FONT color="green">696</FONT>    <a name="line.696"></a>
<FONT color="green">697</FONT>        URL getSourceURL()<a name="line.697"></a>
<FONT color="green">698</FONT>        {<a name="line.698"></a>
<FONT color="green">699</FONT>            return sourceURL;<a name="line.699"></a>
<FONT color="green">700</FONT>        }<a name="line.700"></a>
<FONT color="green">701</FONT>    <a name="line.701"></a>
<FONT color="green">702</FONT>        /**<a name="line.702"></a>
<FONT color="green">703</FONT>         * Return the URL where the configuration is stored.<a name="line.703"></a>
<FONT color="green">704</FONT>         *<a name="line.704"></a>
<FONT color="green">705</FONT>         * @return the configuration's location as URL<a name="line.705"></a>
<FONT color="green">706</FONT>         */<a name="line.706"></a>
<FONT color="green">707</FONT>        public URL getURL()<a name="line.707"></a>
<FONT color="green">708</FONT>        {<a name="line.708"></a>
<FONT color="green">709</FONT>            return (sourceURL != null) ? sourceURL<a name="line.709"></a>
<FONT color="green">710</FONT>                    : ConfigurationUtils.locate(this.fileSystem, getBasePath(), getFileName());<a name="line.710"></a>
<FONT color="green">711</FONT>        }<a name="line.711"></a>
<FONT color="green">712</FONT>    <a name="line.712"></a>
<FONT color="green">713</FONT>        /**<a name="line.713"></a>
<FONT color="green">714</FONT>         * Set the location of this configuration as a URL. For loading this can be<a name="line.714"></a>
<FONT color="green">715</FONT>         * an arbitrary URL with a supported protocol. If the configuration is to<a name="line.715"></a>
<FONT color="green">716</FONT>         * be saved, too, a URL with the &amp;quot;file&amp;quot; protocol should be<a name="line.716"></a>
<FONT color="green">717</FONT>         * provided.<a name="line.717"></a>
<FONT color="green">718</FONT>         *<a name="line.718"></a>
<FONT color="green">719</FONT>         * @param url the location of this configuration as URL<a name="line.719"></a>
<FONT color="green">720</FONT>         */<a name="line.720"></a>
<FONT color="green">721</FONT>        public void setURL(URL url)<a name="line.721"></a>
<FONT color="green">722</FONT>        {<a name="line.722"></a>
<FONT color="green">723</FONT>            setBasePath(ConfigurationUtils.getBasePath(url));<a name="line.723"></a>
<FONT color="green">724</FONT>            setFileName(ConfigurationUtils.getFileName(url));<a name="line.724"></a>
<FONT color="green">725</FONT>            sourceURL = url;<a name="line.725"></a>
<FONT color="green">726</FONT>            getLogger().debug("URL set to " + url);<a name="line.726"></a>
<FONT color="green">727</FONT>        }<a name="line.727"></a>
<FONT color="green">728</FONT>    <a name="line.728"></a>
<FONT color="green">729</FONT>        public void setAutoSave(boolean autoSave)<a name="line.729"></a>
<FONT color="green">730</FONT>        {<a name="line.730"></a>
<FONT color="green">731</FONT>            this.autoSave = autoSave;<a name="line.731"></a>
<FONT color="green">732</FONT>        }<a name="line.732"></a>
<FONT color="green">733</FONT>    <a name="line.733"></a>
<FONT color="green">734</FONT>        public boolean isAutoSave()<a name="line.734"></a>
<FONT color="green">735</FONT>        {<a name="line.735"></a>
<FONT color="green">736</FONT>            return autoSave;<a name="line.736"></a>
<FONT color="green">737</FONT>        }<a name="line.737"></a>
<FONT color="green">738</FONT>    <a name="line.738"></a>
<FONT color="green">739</FONT>        /**<a name="line.739"></a>
<FONT color="green">740</FONT>         * Save the configuration if the automatic persistence is enabled<a name="line.740"></a>
<FONT color="green">741</FONT>         * and if a file is specified.<a name="line.741"></a>
<FONT color="green">742</FONT>         */<a name="line.742"></a>
<FONT color="green">743</FONT>        protected void possiblySave()<a name="line.743"></a>
<FONT color="green">744</FONT>        {<a name="line.744"></a>
<FONT color="green">745</FONT>            if (autoSave &amp;&amp; fileName != null)<a name="line.745"></a>
<FONT color="green">746</FONT>            {<a name="line.746"></a>
<FONT color="green">747</FONT>                try<a name="line.747"></a>
<FONT color="green">748</FONT>                {<a name="line.748"></a>
<FONT color="green">749</FONT>                    save();<a name="line.749"></a>
<FONT color="green">750</FONT>                }<a name="line.750"></a>
<FONT color="green">751</FONT>                catch (ConfigurationException e)<a name="line.751"></a>
<FONT color="green">752</FONT>                {<a name="line.752"></a>
<FONT color="green">753</FONT>                    throw new ConfigurationRuntimeException("Failed to auto-save", e);<a name="line.753"></a>
<FONT color="green">754</FONT>                }<a name="line.754"></a>
<FONT color="green">755</FONT>            }<a name="line.755"></a>
<FONT color="green">756</FONT>        }<a name="line.756"></a>
<FONT color="green">757</FONT>    <a name="line.757"></a>
<FONT color="green">758</FONT>        /**<a name="line.758"></a>
<FONT color="green">759</FONT>         * Adds a new property to this configuration. This implementation checks if<a name="line.759"></a>
<FONT color="green">760</FONT>         * the auto save mode is enabled and saves the configuration if necessary.<a name="line.760"></a>
<FONT color="green">761</FONT>         *<a name="line.761"></a>
<FONT color="green">762</FONT>         * @param key the key of the new property<a name="line.762"></a>
<FONT color="green">763</FONT>         * @param value the value<a name="line.763"></a>
<FONT color="green">764</FONT>         */<a name="line.764"></a>
<FONT color="green">765</FONT>        @Override<a name="line.765"></a>
<FONT color="green">766</FONT>        public void addProperty(String key, Object value)<a name="line.766"></a>
<FONT color="green">767</FONT>        {<a name="line.767"></a>
<FONT color="green">768</FONT>            synchronized (reloadLock)<a name="line.768"></a>
<FONT color="green">769</FONT>            {<a name="line.769"></a>
<FONT color="green">770</FONT>                super.addProperty(key, value);<a name="line.770"></a>
<FONT color="green">771</FONT>                possiblySave();<a name="line.771"></a>
<FONT color="green">772</FONT>            }<a name="line.772"></a>
<FONT color="green">773</FONT>        }<a name="line.773"></a>
<FONT color="green">774</FONT>    <a name="line.774"></a>
<FONT color="green">775</FONT>        /**<a name="line.775"></a>
<FONT color="green">776</FONT>         * Sets a new value for the specified property. This implementation checks<a name="line.776"></a>
<FONT color="green">777</FONT>         * if the auto save mode is enabled and saves the configuration if<a name="line.777"></a>
<FONT color="green">778</FONT>         * necessary.<a name="line.778"></a>
<FONT color="green">779</FONT>         *<a name="line.779"></a>
<FONT color="green">780</FONT>         * @param key the key of the affected property<a name="line.780"></a>
<FONT color="green">781</FONT>         * @param value the value<a name="line.781"></a>
<FONT color="green">782</FONT>         */<a name="line.782"></a>
<FONT color="green">783</FONT>        @Override<a name="line.783"></a>
<FONT color="green">784</FONT>        public void setProperty(String key, Object value)<a name="line.784"></a>
<FONT color="green">785</FONT>        {<a name="line.785"></a>
<FONT color="green">786</FONT>            synchronized (reloadLock)<a name="line.786"></a>
<FONT color="green">787</FONT>            {<a name="line.787"></a>
<FONT color="green">788</FONT>                super.setProperty(key, value);<a name="line.788"></a>
<FONT color="green">789</FONT>                possiblySave();<a name="line.789"></a>
<FONT color="green">790</FONT>            }<a name="line.790"></a>
<FONT color="green">791</FONT>        }<a name="line.791"></a>
<FONT color="green">792</FONT>    <a name="line.792"></a>
<FONT color="green">793</FONT>        @Override<a name="line.793"></a>
<FONT color="green">794</FONT>        public void clearProperty(String key)<a name="line.794"></a>
<FONT color="green">795</FONT>        {<a name="line.795"></a>
<FONT color="green">796</FONT>            synchronized (reloadLock)<a name="line.796"></a>
<FONT color="green">797</FONT>            {<a name="line.797"></a>
<FONT color="green">798</FONT>                super.clearProperty(key);<a name="line.798"></a>
<FONT color="green">799</FONT>                possiblySave();<a name="line.799"></a>
<FONT color="green">800</FONT>            }<a name="line.800"></a>
<FONT color="green">801</FONT>        }<a name="line.801"></a>
<FONT color="green">802</FONT>    <a name="line.802"></a>
<FONT color="green">803</FONT>        public ReloadingStrategy getReloadingStrategy()<a name="line.803"></a>
<FONT color="green">804</FONT>        {<a name="line.804"></a>
<FONT color="green">805</FONT>            return strategy;<a name="line.805"></a>
<FONT color="green">806</FONT>        }<a name="line.806"></a>
<FONT color="green">807</FONT>    <a name="line.807"></a>
<FONT color="green">808</FONT>        public void setReloadingStrategy(ReloadingStrategy strategy)<a name="line.808"></a>
<FONT color="green">809</FONT>        {<a name="line.809"></a>
<FONT color="green">810</FONT>            this.strategy = strategy;<a name="line.810"></a>
<FONT color="green">811</FONT>            strategy.setConfiguration(this);<a name="line.811"></a>
<FONT color="green">812</FONT>            strategy.init();<a name="line.812"></a>
<FONT color="green">813</FONT>        }<a name="line.813"></a>
<FONT color="green">814</FONT>    <a name="line.814"></a>
<FONT color="green">815</FONT>        /**<a name="line.815"></a>
<FONT color="green">816</FONT>         * Performs a reload operation if necessary. This method is called on each<a name="line.816"></a>
<FONT color="green">817</FONT>         * access of this configuration. It asks the associated reloading strategy<a name="line.817"></a>
<FONT color="green">818</FONT>         * whether a reload should be performed. If this is the case, the<a name="line.818"></a>
<FONT color="green">819</FONT>         * configuration is cleared and loaded again from its source. If this<a name="line.819"></a>
<FONT color="green">820</FONT>         * operation causes an exception, the registered error listeners will be<a name="line.820"></a>
<FONT color="green">821</FONT>         * notified. The error event passed to the listeners is of type<a name="line.821"></a>
<FONT color="green">822</FONT>         * {@code EVENT_RELOAD} and contains the exception that caused the<a name="line.822"></a>
<FONT color="green">823</FONT>         * event.<a name="line.823"></a>
<FONT color="green">824</FONT>         */<a name="line.824"></a>
<FONT color="green">825</FONT>        public void reload()<a name="line.825"></a>
<FONT color="green">826</FONT>        {<a name="line.826"></a>
<FONT color="green">827</FONT>            reload(false);<a name="line.827"></a>
<FONT color="green">828</FONT>        }<a name="line.828"></a>
<FONT color="green">829</FONT>    <a name="line.829"></a>
<FONT color="green">830</FONT>        public boolean reload(boolean checkReload)<a name="line.830"></a>
<FONT color="green">831</FONT>        {<a name="line.831"></a>
<FONT color="green">832</FONT>            synchronized (reloadLock)<a name="line.832"></a>
<FONT color="green">833</FONT>            {<a name="line.833"></a>
<FONT color="green">834</FONT>                if (noReload == 0)<a name="line.834"></a>
<FONT color="green">835</FONT>                {<a name="line.835"></a>
<FONT color="green">836</FONT>                    try<a name="line.836"></a>
<FONT color="green">837</FONT>                    {<a name="line.837"></a>
<FONT color="green">838</FONT>                        enterNoReload(); // avoid reentrant calls<a name="line.838"></a>
<FONT color="green">839</FONT>    <a name="line.839"></a>
<FONT color="green">840</FONT>                        if (strategy.reloadingRequired())<a name="line.840"></a>
<FONT color="green">841</FONT>                        {<a name="line.841"></a>
<FONT color="green">842</FONT>                            if (getLogger().isInfoEnabled())<a name="line.842"></a>
<FONT color="green">843</FONT>                            {<a name="line.843"></a>
<FONT color="green">844</FONT>                                getLogger().info("Reloading configuration. URL is " + getURL());<a name="line.844"></a>
<FONT color="green">845</FONT>                            }<a name="line.845"></a>
<FONT color="green">846</FONT>                            refresh();<a name="line.846"></a>
<FONT color="green">847</FONT>    <a name="line.847"></a>
<FONT color="green">848</FONT>                            // notify the strategy<a name="line.848"></a>
<FONT color="green">849</FONT>                            strategy.reloadingPerformed();<a name="line.849"></a>
<FONT color="green">850</FONT>                        }<a name="line.850"></a>
<FONT color="green">851</FONT>                    }<a name="line.851"></a>
<FONT color="green">852</FONT>                    catch (Exception e)<a name="line.852"></a>
<FONT color="green">853</FONT>                    {<a name="line.853"></a>
<FONT color="green">854</FONT>                        fireError(EVENT_RELOAD, null, null, e);<a name="line.854"></a>
<FONT color="green">855</FONT>                        // todo rollback the changes if the file can't be reloaded<a name="line.855"></a>
<FONT color="green">856</FONT>                        if (checkReload)<a name="line.856"></a>
<FONT color="green">857</FONT>                        {<a name="line.857"></a>
<FONT color="green">858</FONT>                            return false;<a name="line.858"></a>
<FONT color="green">859</FONT>                        }<a name="line.859"></a>
<FONT color="green">860</FONT>                    }<a name="line.860"></a>
<FONT color="green">861</FONT>                    finally<a name="line.861"></a>
<FONT color="green">862</FONT>                    {<a name="line.862"></a>
<FONT color="green">863</FONT>                        exitNoReload();<a name="line.863"></a>
<FONT color="green">864</FONT>                    }<a name="line.864"></a>
<FONT color="green">865</FONT>                }<a name="line.865"></a>
<FONT color="green">866</FONT>            }<a name="line.866"></a>
<FONT color="green">867</FONT>            return true;<a name="line.867"></a>
<FONT color="green">868</FONT>        }<a name="line.868"></a>
<FONT color="green">869</FONT>    <a name="line.869"></a>
<FONT color="green">870</FONT>        /**<a name="line.870"></a>
<FONT color="green">871</FONT>         * Reloads the associated configuration file. This method first clears the<a name="line.871"></a>
<FONT color="green">872</FONT>         * content of this configuration, then the associated configuration file is<a name="line.872"></a>
<FONT color="green">873</FONT>         * loaded again. Updates on this configuration which have not yet been saved<a name="line.873"></a>
<FONT color="green">874</FONT>         * are lost. Calling this method is like invoking {@code reload()}<a name="line.874"></a>
<FONT color="green">875</FONT>         * without checking the reloading strategy.<a name="line.875"></a>
<FONT color="green">876</FONT>         *<a name="line.876"></a>
<FONT color="green">877</FONT>         * @throws ConfigurationException if an error occurs<a name="line.877"></a>
<FONT color="green">878</FONT>         * @since 1.7<a name="line.878"></a>
<FONT color="green">879</FONT>         */<a name="line.879"></a>
<FONT color="green">880</FONT>        public void refresh() throws ConfigurationException<a name="line.880"></a>
<FONT color="green">881</FONT>        {<a name="line.881"></a>
<FONT color="green">882</FONT>            fireEvent(EVENT_RELOAD, null, getURL(), true);<a name="line.882"></a>
<FONT color="green">883</FONT>            setDetailEvents(false);<a name="line.883"></a>
<FONT color="green">884</FONT>            boolean autoSaveBak = this.isAutoSave(); // save the current state<a name="line.884"></a>
<FONT color="green">885</FONT>            this.setAutoSave(false); // deactivate autoSave to prevent information loss<a name="line.885"></a>
<FONT color="green">886</FONT>            try<a name="line.886"></a>
<FONT color="green">887</FONT>            {<a name="line.887"></a>
<FONT color="green">888</FONT>                clear();<a name="line.888"></a>
<FONT color="green">889</FONT>                load();<a name="line.889"></a>
<FONT color="green">890</FONT>            }<a name="line.890"></a>
<FONT color="green">891</FONT>            finally<a name="line.891"></a>
<FONT color="green">892</FONT>            {<a name="line.892"></a>
<FONT color="green">893</FONT>                this.setAutoSave(autoSaveBak); // set autoSave to previous value<a name="line.893"></a>
<FONT color="green">894</FONT>                setDetailEvents(true);<a name="line.894"></a>
<FONT color="green">895</FONT>            }<a name="line.895"></a>
<FONT color="green">896</FONT>            fireEvent(EVENT_RELOAD, null, getURL(), false);<a name="line.896"></a>
<FONT color="green">897</FONT>        }<a name="line.897"></a>
<FONT color="green">898</FONT>    <a name="line.898"></a>
<FONT color="green">899</FONT>        /**<a name="line.899"></a>
<FONT color="green">900</FONT>         * Send notification that the configuration has changed.<a name="line.900"></a>
<FONT color="green">901</FONT>         */<a name="line.901"></a>
<FONT color="green">902</FONT>        public void configurationChanged()<a name="line.902"></a>
<FONT color="green">903</FONT>        {<a name="line.903"></a>
<FONT color="green">904</FONT>            fireEvent(EVENT_CONFIG_CHANGED, null, getURL(), true);<a name="line.904"></a>
<FONT color="green">905</FONT>        }<a name="line.905"></a>
<FONT color="green">906</FONT>    <a name="line.906"></a>
<FONT color="green">907</FONT>        /**<a name="line.907"></a>
<FONT color="green">908</FONT>         * Enters the &amp;quot;No reloading mode&amp;quot;. As long as this mode is active<a name="line.908"></a>
<FONT color="green">909</FONT>         * no reloading will be performed. This is necessary for some<a name="line.909"></a>
<FONT color="green">910</FONT>         * implementations of {@code save()} in derived classes, which may<a name="line.910"></a>
<FONT color="green">911</FONT>         * cause a reload while accessing the properties to save. This may cause the<a name="line.911"></a>
<FONT color="green">912</FONT>         * whole configuration to be erased. To avoid this, this method can be<a name="line.912"></a>
<FONT color="green">913</FONT>         * called first. After a call to this method there always must be a<a name="line.913"></a>
<FONT color="green">914</FONT>         * corresponding call of {@link #exitNoReload()} later! (If<a name="line.914"></a>
<FONT color="green">915</FONT>         * necessary, {@code finally} blocks must be used to ensure this.<a name="line.915"></a>
<FONT color="green">916</FONT>         */<a name="line.916"></a>
<FONT color="green">917</FONT>        protected void enterNoReload()<a name="line.917"></a>
<FONT color="green">918</FONT>        {<a name="line.918"></a>
<FONT color="green">919</FONT>            synchronized (reloadLock)<a name="line.919"></a>
<FONT color="green">920</FONT>            {<a name="line.920"></a>
<FONT color="green">921</FONT>                noReload++;<a name="line.921"></a>
<FONT color="green">922</FONT>            }<a name="line.922"></a>
<FONT color="green">923</FONT>        }<a name="line.923"></a>
<FONT color="green">924</FONT>    <a name="line.924"></a>
<FONT color="green">925</FONT>        /**<a name="line.925"></a>
<FONT color="green">926</FONT>         * Leaves the &amp;quot;No reloading mode&amp;quot;.<a name="line.926"></a>
<FONT color="green">927</FONT>         *<a name="line.927"></a>
<FONT color="green">928</FONT>         * @see #enterNoReload()<a name="line.928"></a>
<FONT color="green">929</FONT>         */<a name="line.929"></a>
<FONT color="green">930</FONT>        protected void exitNoReload()<a name="line.930"></a>
<FONT color="green">931</FONT>        {<a name="line.931"></a>
<FONT color="green">932</FONT>            synchronized (reloadLock)<a name="line.932"></a>
<FONT color="green">933</FONT>            {<a name="line.933"></a>
<FONT color="green">934</FONT>                if (noReload &gt; 0) // paranoia check<a name="line.934"></a>
<FONT color="green">935</FONT>                {<a name="line.935"></a>
<FONT color="green">936</FONT>                    noReload--;<a name="line.936"></a>
<FONT color="green">937</FONT>                }<a name="line.937"></a>
<FONT color="green">938</FONT>            }<a name="line.938"></a>
<FONT color="green">939</FONT>        }<a name="line.939"></a>
<FONT color="green">940</FONT>    <a name="line.940"></a>
<FONT color="green">941</FONT>        /**<a name="line.941"></a>
<FONT color="green">942</FONT>         * Sends an event to all registered listeners. This implementation ensures<a name="line.942"></a>
<FONT color="green">943</FONT>         * that no reloads are performed while the listeners are invoked. So<a name="line.943"></a>
<FONT color="green">944</FONT>         * infinite loops can be avoided that can be caused by event listeners<a name="line.944"></a>
<FONT color="green">945</FONT>         * accessing the configuration's properties when they are invoked.<a name="line.945"></a>
<FONT color="green">946</FONT>         *<a name="line.946"></a>
<FONT color="green">947</FONT>         * @param type the event type<a name="line.947"></a>
<FONT color="green">948</FONT>         * @param propName the name of the property<a name="line.948"></a>
<FONT color="green">949</FONT>         * @param propValue the value of the property<a name="line.949"></a>
<FONT color="green">950</FONT>         * @param before the before update flag<a name="line.950"></a>
<FONT color="green">951</FONT>         */<a name="line.951"></a>
<FONT color="green">952</FONT>        @Override<a name="line.952"></a>
<FONT color="green">953</FONT>        protected void fireEvent(int type, String propName, Object propValue, boolean before)<a name="line.953"></a>
<FONT color="green">954</FONT>        {<a name="line.954"></a>
<FONT color="green">955</FONT>            enterNoReload();<a name="line.955"></a>
<FONT color="green">956</FONT>            try<a name="line.956"></a>
<FONT color="green">957</FONT>            {<a name="line.957"></a>
<FONT color="green">958</FONT>                super.fireEvent(type, propName, propValue, before);<a name="line.958"></a>
<FONT color="green">959</FONT>            }<a name="line.959"></a>
<FONT color="green">960</FONT>            finally<a name="line.960"></a>
<FONT color="green">961</FONT>            {<a name="line.961"></a>
<FONT color="green">962</FONT>                exitNoReload();<a name="line.962"></a>
<FONT color="green">963</FONT>            }<a name="line.963"></a>
<FONT color="green">964</FONT>        }<a name="line.964"></a>
<FONT color="green">965</FONT>    <a name="line.965"></a>
<FONT color="green">966</FONT>        @Override<a name="line.966"></a>
<FONT color="green">967</FONT>        public Object getProperty(String key)<a name="line.967"></a>
<FONT color="green">968</FONT>        {<a name="line.968"></a>
<FONT color="green">969</FONT>            synchronized (reloadLock)<a name="line.969"></a>
<FONT color="green">970</FONT>            {<a name="line.970"></a>
<FONT color="green">971</FONT>                reload();<a name="line.971"></a>
<FONT color="green">972</FONT>                return super.getProperty(key);<a name="line.972"></a>
<FONT color="green">973</FONT>            }<a name="line.973"></a>
<FONT color="green">974</FONT>        }<a name="line.974"></a>
<FONT color="green">975</FONT>    <a name="line.975"></a>
<FONT color="green">976</FONT>        @Override<a name="line.976"></a>
<FONT color="green">977</FONT>        public boolean isEmpty()<a name="line.977"></a>
<FONT color="green">978</FONT>        {<a name="line.978"></a>
<FONT color="green">979</FONT>            reload();<a name="line.979"></a>
<FONT color="green">980</FONT>            synchronized (reloadLock)<a name="line.980"></a>
<FONT color="green">981</FONT>            {<a name="line.981"></a>
<FONT color="green">982</FONT>                return super.isEmpty();<a name="line.982"></a>
<FONT color="green">983</FONT>            }<a name="line.983"></a>
<FONT color="green">984</FONT>        }<a name="line.984"></a>
<FONT color="green">985</FONT>    <a name="line.985"></a>
<FONT color="green">986</FONT>        @Override<a name="line.986"></a>
<FONT color="green">987</FONT>        public boolean containsKey(String key)<a name="line.987"></a>
<FONT color="green">988</FONT>        {<a name="line.988"></a>
<FONT color="green">989</FONT>            reload();<a name="line.989"></a>
<FONT color="green">990</FONT>            synchronized (reloadLock)<a name="line.990"></a>
<FONT color="green">991</FONT>            {<a name="line.991"></a>
<FONT color="green">992</FONT>                return super.containsKey(key);<a name="line.992"></a>
<FONT color="green">993</FONT>            }<a name="line.993"></a>
<FONT color="green">994</FONT>        }<a name="line.994"></a>
<FONT color="green">995</FONT>    <a name="line.995"></a>
<FONT color="green">996</FONT>        /**<a name="line.996"></a>
<FONT color="green">997</FONT>         * Returns an {@code Iterator} with the keys contained in this<a name="line.997"></a>
<FONT color="green">998</FONT>         * configuration. This implementation performs a reload if necessary before<a name="line.998"></a>
<FONT color="green">999</FONT>         * obtaining the keys. The {@code Iterator} returned by this method<a name="line.999"></a>
<FONT color="green">1000</FONT>         * points to a snapshot taken when this method was called. Later changes at<a name="line.1000"></a>
<FONT color="green">1001</FONT>         * the set of keys (including those caused by a reload) won't be visible.<a name="line.1001"></a>
<FONT color="green">1002</FONT>         * This is because a reload can happen at any time during iteration, and it<a name="line.1002"></a>
<FONT color="green">1003</FONT>         * is impossible to determine how this reload affects the current iteration.<a name="line.1003"></a>
<FONT color="green">1004</FONT>         * When using the iterator a client has to be aware that changes of the<a name="line.1004"></a>
<FONT color="green">1005</FONT>         * configuration are possible at any time. For instance, if after a reload<a name="line.1005"></a>
<FONT color="green">1006</FONT>         * operation some keys are no longer present, the iterator will still return<a name="line.1006"></a>
<FONT color="green">1007</FONT>         * those keys because they were found when it was created.<a name="line.1007"></a>
<FONT color="green">1008</FONT>         *<a name="line.1008"></a>
<FONT color="green">1009</FONT>         * @return an {@code Iterator} with the keys of this configuration<a name="line.1009"></a>
<FONT color="green">1010</FONT>         */<a name="line.1010"></a>
<FONT color="green">1011</FONT>        @Override<a name="line.1011"></a>
<FONT color="green">1012</FONT>        public Iterator&lt;String&gt; getKeys()<a name="line.1012"></a>
<FONT color="green">1013</FONT>        {<a name="line.1013"></a>
<FONT color="green">1014</FONT>            reload();<a name="line.1014"></a>
<FONT color="green">1015</FONT>            List&lt;String&gt; keyList = new LinkedList&lt;String&gt;();<a name="line.1015"></a>
<FONT color="green">1016</FONT>            enterNoReload();<a name="line.1016"></a>
<FONT color="green">1017</FONT>            try<a name="line.1017"></a>
<FONT color="green">1018</FONT>            {<a name="line.1018"></a>
<FONT color="green">1019</FONT>                for (Iterator&lt;String&gt; it = super.getKeys(); it.hasNext();)<a name="line.1019"></a>
<FONT color="green">1020</FONT>                {<a name="line.1020"></a>
<FONT color="green">1021</FONT>                    keyList.add(it.next());<a name="line.1021"></a>
<FONT color="green">1022</FONT>                }<a name="line.1022"></a>
<FONT color="green">1023</FONT>    <a name="line.1023"></a>
<FONT color="green">1024</FONT>                return keyList.iterator();<a name="line.1024"></a>
<FONT color="green">1025</FONT>            }<a name="line.1025"></a>
<FONT color="green">1026</FONT>            finally<a name="line.1026"></a>
<FONT color="green">1027</FONT>            {<a name="line.1027"></a>
<FONT color="green">1028</FONT>                exitNoReload();<a name="line.1028"></a>
<FONT color="green">1029</FONT>            }<a name="line.1029"></a>
<FONT color="green">1030</FONT>        }<a name="line.1030"></a>
<FONT color="green">1031</FONT>    <a name="line.1031"></a>
<FONT color="green">1032</FONT>        public String getEncoding()<a name="line.1032"></a>
<FONT color="green">1033</FONT>        {<a name="line.1033"></a>
<FONT color="green">1034</FONT>            return encoding;<a name="line.1034"></a>
<FONT color="green">1035</FONT>        }<a name="line.1035"></a>
<FONT color="green">1036</FONT>    <a name="line.1036"></a>
<FONT color="green">1037</FONT>        public void setEncoding(String encoding)<a name="line.1037"></a>
<FONT color="green">1038</FONT>        {<a name="line.1038"></a>
<FONT color="green">1039</FONT>            this.encoding = encoding;<a name="line.1039"></a>
<FONT color="green">1040</FONT>        }<a name="line.1040"></a>
<FONT color="green">1041</FONT>    <a name="line.1041"></a>
<FONT color="green">1042</FONT>        /**<a name="line.1042"></a>
<FONT color="green">1043</FONT>         * Creates a copy of this configuration. The new configuration object will<a name="line.1043"></a>
<FONT color="green">1044</FONT>         * contain the same properties as the original, but it will lose any<a name="line.1044"></a>
<FONT color="green">1045</FONT>         * connection to a source file (if one exists); this includes setting the<a name="line.1045"></a>
<FONT color="green">1046</FONT>         * source URL, base path, and file name to &lt;b&gt;null&lt;/b&gt;. This is done to<a name="line.1046"></a>
<FONT color="green">1047</FONT>         * avoid race conditions if both the original and the copy are modified and<a name="line.1047"></a>
<FONT color="green">1048</FONT>         * then saved.<a name="line.1048"></a>
<FONT color="green">1049</FONT>         *<a name="line.1049"></a>
<FONT color="green">1050</FONT>         * @return the copy<a name="line.1050"></a>
<FONT color="green">1051</FONT>         * @since 1.3<a name="line.1051"></a>
<FONT color="green">1052</FONT>         */<a name="line.1052"></a>
<FONT color="green">1053</FONT>        @Override<a name="line.1053"></a>
<FONT color="green">1054</FONT>        public Object clone()<a name="line.1054"></a>
<FONT color="green">1055</FONT>        {<a name="line.1055"></a>
<FONT color="green">1056</FONT>            AbstractFileConfiguration copy = (AbstractFileConfiguration) super.clone();<a name="line.1056"></a>
<FONT color="green">1057</FONT>            copy.setBasePath(null);<a name="line.1057"></a>
<FONT color="green">1058</FONT>            copy.setFileName(null);<a name="line.1058"></a>
<FONT color="green">1059</FONT>            copy.initReloadingStrategy();<a name="line.1059"></a>
<FONT color="green">1060</FONT>            return copy;<a name="line.1060"></a>
<FONT color="green">1061</FONT>        }<a name="line.1061"></a>
<FONT color="green">1062</FONT>    <a name="line.1062"></a>
<FONT color="green">1063</FONT>        /**<a name="line.1063"></a>
<FONT color="green">1064</FONT>         * Helper method for initializing the reloading strategy.<a name="line.1064"></a>
<FONT color="green">1065</FONT>         */<a name="line.1065"></a>
<FONT color="green">1066</FONT>        private void initReloadingStrategy()<a name="line.1066"></a>
<FONT color="green">1067</FONT>        {<a name="line.1067"></a>
<FONT color="green">1068</FONT>            setReloadingStrategy(new InvariantReloadingStrategy());<a name="line.1068"></a>
<FONT color="green">1069</FONT>        }<a name="line.1069"></a>
<FONT color="green">1070</FONT>    <a name="line.1070"></a>
<FONT color="green">1071</FONT>        /**<a name="line.1071"></a>
<FONT color="green">1072</FONT>         * A helper method for closing an output stream. Occurring exceptions will<a name="line.1072"></a>
<FONT color="green">1073</FONT>         * be ignored.<a name="line.1073"></a>
<FONT color="green">1074</FONT>         *<a name="line.1074"></a>
<FONT color="green">1075</FONT>         * @param out the output stream to be closed (may be &lt;b&gt;null&lt;/b&gt;)<a name="line.1075"></a>
<FONT color="green">1076</FONT>         * @since 1.5<a name="line.1076"></a>
<FONT color="green">1077</FONT>         */<a name="line.1077"></a>
<FONT color="green">1078</FONT>        protected void closeSilent(OutputStream out)<a name="line.1078"></a>
<FONT color="green">1079</FONT>        {<a name="line.1079"></a>
<FONT color="green">1080</FONT>            try<a name="line.1080"></a>
<FONT color="green">1081</FONT>            {<a name="line.1081"></a>
<FONT color="green">1082</FONT>                if (out != null)<a name="line.1082"></a>
<FONT color="green">1083</FONT>                {<a name="line.1083"></a>
<FONT color="green">1084</FONT>                    out.close();<a name="line.1084"></a>
<FONT color="green">1085</FONT>                }<a name="line.1085"></a>
<FONT color="green">1086</FONT>            }<a name="line.1086"></a>
<FONT color="green">1087</FONT>            catch (IOException e)<a name="line.1087"></a>
<FONT color="green">1088</FONT>            {<a name="line.1088"></a>
<FONT color="green">1089</FONT>                getLogger().warn("Could not close output stream", e);<a name="line.1089"></a>
<FONT color="green">1090</FONT>            }<a name="line.1090"></a>
<FONT color="green">1091</FONT>        }<a name="line.1091"></a>
<FONT color="green">1092</FONT>    }<a name="line.1092"></a>




























































</PRE>
</BODY>
</HTML>
